Set-RASAVDHostPool

NAME

Set-RASAVDHostPool

SYNOPSIS

Modifies a Azure Virtual Desktop Host Pool.

SYNTAX

Set-RASAVDHostPool [-Id] <uint> [-AllowRemoteExec <bool>] [-AllowURLAndMailRedirection {Disabled | Enabled | EnabledWithAppRegistration}] [-AppMonitor <bool>] [-AutoScaleEnabled <bool>] [-DefaultLicenseType {DoNotConfigure | WindowsClient | WindowsServer}] [-DefaultPowerState {PoweredOn | PoweredOff | Suspended}] [-Description <string>] [-DisconnectActiveSessionAfter <uint>] [-DragAndDropMode {Disabled | ClientToServer | ServerToClient | Bidirectional}] [-DrainRemains <uint>] [-Enabled <bool>] [-EnableDriveRedirectionCache <bool>] [-FileTransferLocation <string>] [-FileTransferLockLocation <bool>] [-FileTransferMode {Disabled | ClientToServer | ServerToClient | Bidirectional}] [-HostName <string>] [-InheritDefaultActionsSettings <bool>] [-InheritDefaultAgentSettings <bool>] [-InheritDefaultAppPackageSettings <bool>] [-InheritDefaultOptimizationSettings <bool>] [-InheritDefaultRDPPrinterSettings <bool>] [-InheritDefaultUserProfileSettings <bool>] [-LimitHosts <uint>] [-LoadBalancerType {BreadthFirst | DepthFirst | Persistent}] [-LogoffDisconnectedSessionAfter <uint>] [-ManageRDPShortpath <bool>] [-ManageRDPTransportProtocol {Disabled | BothUDPTCP | OnlyTCP | EitherUDPTCP}] [-MaxRDPShortpathPort <uint>] [-MaxServersFromTemplate <uint>] [-MinRDPShortpathPort <uint>] [-MinServersFromTemplate <uint>] [-NewName <string>] [-OverwriteSize <bool>] [-PerformAction {DoNothing | Shutdown | Suspend | Delete | Restart | Unassign | Recreate}] [-PerformActionAfterSec <uint>] [-PowerOnHost <bool>] [-PrinterNameFormat {PrnFormat_PRN_CMP_SES | PrnFormat_SES_CMP_PRN | PrnFormat_PRN_REDSES}] [-RemoveClientNameFromPrinterName <bool>] [-RemoveServersAfterDrainAndPowerOff <bool>] [-RemoveSessionNumberFromPrinterName <bool>] [-ServersToAddPerRequest <uint>] [-SessionAction {Disconnect | Logoff}] [-SessionReadinessTimeout <uint>] [-SupportShellURLNamespaceObjects <bool>] [-Technology {DoNotManage | UPD | FSLogix | FSLogixProfileContainer}] [-TemplateId <uint>] [-TemplateVersionId <uint>] [-UseRDPShortpath <bool>] [-UseSmallerPortRange <bool>] [-ValidationEnvironment <bool>] [-WorkLoadDrain <uint>] [-WorkloadThreshold <uint>] [<CommonParameters>]

Set-RASAVDHostPool [-InputObject] <AVDHostPool> [-AllowRemoteExec <bool>] [-AllowURLAndMailRedirection {Disabled | Enabled | EnabledWithAppRegistration}] [-AppMonitor <bool>] [-AutoScaleEnabled <bool>] [-DefaultLicenseType {DoNotConfigure | WindowsClient | WindowsServer}] [-DefaultPowerState {PoweredOn | PoweredOff | Suspended}] [-Description <string>] [-DisconnectActiveSessionAfter <uint>] [-DragAndDropMode {Disabled | ClientToServer | ServerToClient | Bidirectional}] [-DrainRemains <uint>] [-Enabled <bool>] [-EnableDriveRedirectionCache <bool>] [-FileTransferLocation <string>] [-FileTransferLockLocation <bool>] [-FileTransferMode {Disabled | ClientToServer | ServerToClient | Bidirectional}] [-HostName <string>] [-InheritDefaultActionsSettings <bool>] [-InheritDefaultAgentSettings <bool>] [-InheritDefaultAppPackageSettings <bool>] [-InheritDefaultOptimizationSettings <bool>] [-InheritDefaultRDPPrinterSettings <bool>] [-InheritDefaultUserProfileSettings <bool>] [-LimitHosts <uint>] [-LoadBalancerType {BreadthFirst | DepthFirst | Persistent}] [-LogoffDisconnectedSessionAfter <uint>] [-ManageRDPShortpath <bool>] [-ManageRDPTransportProtocol {Disabled | BothUDPTCP | OnlyTCP | EitherUDPTCP}] [-MaxRDPShortpathPort <uint>] [-MaxServersFromTemplate <uint>] [-MinRDPShortpathPort <uint>] [-MinServersFromTemplate <uint>] [-NewName <string>] [-OverwriteSize <bool>] [-PerformAction {DoNothing | Shutdown | Suspend | Delete | Restart | Unassign | Recreate}] [-PerformActionAfterSec <uint>] [-PowerOnHost <bool>] [-PrinterNameFormat {PrnFormat_PRN_CMP_SES | PrnFormat_SES_CMP_PRN | PrnFormat_PRN_REDSES}] [-RemoveClientNameFromPrinterName <bool>] [-RemoveServersAfterDrainAndPowerOff <bool>] [-RemoveSessionNumberFromPrinterName <bool>] [-ServersToAddPerRequest <uint>] [-SessionAction {Disconnect | Logoff}] [-SessionReadinessTimeout <uint>] [-SupportShellURLNamespaceObjects <bool>] [-Technology {DoNotManage | UPD | FSLogix | FSLogixProfileContainer}] [-TemplateId <uint>] [-TemplateVersionId <uint>] [-UseRDPShortpath <bool>] [-UseSmallerPortRange <bool>] [-ValidationEnvironment <bool>] [-WorkLoadDrain <uint>] [-WorkloadThreshold <uint>] [<CommonParameters>]

Set-RASAVDHostPool [-Name] <string> [[-SiteId] <uint>] [-AllowRemoteExec <bool>] [-AllowURLAndMailRedirection {Disabled | Enabled | EnabledWithAppRegistration}] [-AppMonitor <bool>] [-AutoScaleEnabled <bool>] [-DefaultLicenseType {DoNotConfigure | WindowsClient | WindowsServer}] [-DefaultPowerState {PoweredOn | PoweredOff | Suspended}] [-Description <string>] [-DisconnectActiveSessionAfter <uint>] [-DragAndDropMode {Disabled | ClientToServer | ServerToClient | Bidirectional}] [-DrainRemains <uint>] [-Enabled <bool>] [-EnableDriveRedirectionCache <bool>] [-FileTransferLocation <string>] [-FileTransferLockLocation <bool>] [-FileTransferMode {Disabled | ClientToServer | ServerToClient | Bidirectional}] [-HostName <string>] [-InheritDefaultActionsSettings <bool>] [-InheritDefaultAgentSettings <bool>] [-InheritDefaultAppPackageSettings <bool>] [-InheritDefaultOptimizationSettings <bool>] [-InheritDefaultRDPPrinterSettings <bool>] [-InheritDefaultUserProfileSettings <bool>] [-LimitHosts <uint>] [-LoadBalancerType {BreadthFirst | DepthFirst | Persistent}] [-LogoffDisconnectedSessionAfter <uint>] [-ManageRDPShortpath <bool>] [-ManageRDPTransportProtocol {Disabled | BothUDPTCP | OnlyTCP | EitherUDPTCP}] [-MaxRDPShortpathPort <uint>] [-MaxServersFromTemplate <uint>] [-MinRDPShortpathPort <uint>] [-MinServersFromTemplate <uint>] [-NewName <string>] [-OverwriteSize <bool>] [-PerformAction {DoNothing | Shutdown | Suspend | Delete | Restart | Unassign | Recreate}] [-PerformActionAfterSec <uint>] [-PowerOnHost <bool>] [-PrinterNameFormat {PrnFormat_PRN_CMP_SES | PrnFormat_SES_CMP_PRN | PrnFormat_PRN_REDSES}] [-RemoveClientNameFromPrinterName <bool>] [-RemoveServersAfterDrainAndPowerOff <bool>] [-RemoveSessionNumberFromPrinterName <bool>] [-ServersToAddPerRequest <uint>] [-SessionAction {Disconnect | Logoff}] [-SessionReadinessTimeout <uint>] [-SupportShellURLNamespaceObjects <bool>] [-Technology {DoNotManage | UPD | FSLogix | FSLogixProfileContainer}] [-TemplateId <uint>] [-TemplateVersionId <uint>] [-UseRDPShortpath <bool>] [-UseSmallerPortRange <bool>] [-ValidationEnvironment <bool>] [-WorkLoadDrain <uint>] [-WorkloadThreshold <uint>] [<CommonParameters>]

DESCRIPTION

Modifies properties of a Azure Virtual Desktop Host Pool.

This is an Experimental feature which is subject to slight changes.

PARAMETERS


-Id <uint>
ID for which to modify the Azure Virtual Desktop Host Pool settings. 

        Required?                    true
        Position?                    0
        Default value                0
        Accept pipeline input?       false
        Accept wildcard characters?  false

-Name <string>
The name of the target Azure Virtual Desktop Host Pool settings.

This must be the actual Azure Virtual Desktop Host Pool name used in the RAS farm. 

        Required?                    true
        Position?                    0
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-SiteId <uint>
Site ID in which to modify the specified Azure Virtual Desktop Host Pool settings .

If the parameter is omitted, the site ID of the Licensing Server will be used. 

        Required?                    false
        Position?                    1
        Default value                0
        Accept pipeline input?       false
        Accept wildcard characters?  false

-InputObject <AVDHostPool>
An AVD Host Pool object (an object of type AVDHostPool) to modify.

An AVDHostPool object representing a host pool is obtained using the Get-RASAVDHostPool cmdlet. 

        Required?                    true
        Position?                    0
        Default value                
        Accept pipeline input?       true (ByValue)
        Accept wildcard characters?  false

-NewName <string>
The new name of the Azure Virtual Desktop Host Pool settings. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-Description <string>
The new description of the Azure Virtual Desktop Host Pool settings. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-Enabled <bool>
Enable or disable the specified AVD Host Pool in a site. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-PowerOnHost <bool>
Whether Power On Host is Enabled or not. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-ValidationEnvironment <bool>
Whether Validation Environment is Enabled or not. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-LimitHosts <uint>
The Limit of session on host. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-DefaultLicenseType <AVDLicenseType>
The license type.

Possible values: DoNotConfigure, WindowsClient, WindowsServer 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-LoadBalancerType <LoadBalancerType>
The Load Balancer Type of the Host Pool

Possible values: BreadthFirst, DepthFirst, Persistent 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-Technology <UserProfileTech>
Specifies the 'User Profile Technology' value.

Possible values: DoNotManage, UPD, FSLogix, FSLogixProfileContainer 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-DisconnectActiveSessionAfter <uint>
Disconnect active session after (in seconds). Accepted values: 20-1641600 seconds; 0 for 'Never'. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-LogoffDisconnectedSessionAfter <uint>
Logoff disconnected session after (in seconds). Accepted values: 20-1641600 seconds; 0 for 'Never'; 1 for 'Immediate'. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-SessionReadinessTimeout <uint>
Session readiness timeout (in seconds). Accepted values: 20-3600 seconds. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-AllowRemoteExec <bool>
Specifies if 'Allow 2XRemoteExec to send command to the client' option is enabled or disabled. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-AllowURLAndMailRedirection <AllowURLAndMailRedirection>
Specifies the 'Allow Client URL/Mail Redirection'.

Possible values: Disabled, Enabled, EnabledWithAppRegistration 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-SupportShellURLNamespaceObjects <bool>
Specifies if 'Support Shell URL Namespace Objects' option is enabled or disabled. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-ManageRDPTransportProtocol <ManageRDPTransportProtocol>
Manage RDP transport protocol.

Possible values: Disabled, BothUDPTCP, OnlyTCP, EitherUDPTCP 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-DragAndDropMode <DragAndDropModeValue>
Specifies the mode the drag and drop feature will operate.

Possible values: Disabled, ClientToServer, ServerToClient, Bidirectional 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-FileTransferMode <FileTransferControlMode>
Specifies if File Transfer option is allowed and if yes, which directions are allowed.

Possible values: Disabled, ClientToServer, ServerToClient, Bidirectional 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-FileTransferLocation <string>
Location where the File Transfer takes place, if and where it is allowed. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-FileTransferLockLocation <bool>
Lock Location where the File Transfer takes place, if and where it is allowed. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-EnableDriveRedirectionCache <bool>
Specifies if the 'Enable Drive Redirection Cache' option is enabled or disabled. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-SessionAction <SessionAction>
Session Action

Possible values: Disconnect, Logoff 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-PerformAction <PerformAction>
Perform Action

Possible values: DoNothing, Shutdown, Suspend, Delete, Restart, Unassign, Recreate 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-PerformActionAfterSec <uint>
Perform action after (in seconds) 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-TemplateId <uint>
The Template ID. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-TemplateVersionId <uint>
The RAS Template Version ID. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-AutoScaleEnabled <bool>
Whether AutoScale is Enabled or not. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-MinServersFromTemplate <uint>
The Minimum Number of Hosts added to the template. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-MaxServersFromTemplate <uint>
The Maximum Number of Hosts added to the template. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-HostName <string>
The Host name format. All VMs created from the template will have this name with %ID:N:S% replaced. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-DefaultPowerState <DefaultPowerState>
The Default Power State

Possible values: PoweredOn, PoweredOff, Suspended 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-WorkloadThreshold <uint>
The Workload Threshold. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-ServersToAddPerRequest <uint>
The amount of servers to add per request. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-WorkLoadDrain <uint>
The Drain Workload. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-DrainRemains <uint>
The Remaining Drain level. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-OverwriteSize <bool>
The Remaining Drain level. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-RemoveServersAfterDrainAndPowerOff <bool>
Remove hosts from host pool after drain and power off. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-PrinterNameFormat <PrnNameFormat>
Specifies the 'Printer Name Format' option.

Possible values: PrnFormat_PRN_CMP_SES, PrnFormat_SES_CMP_PRN, PrnFormat_PRN_REDSES 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-RemoveSessionNumberFromPrinterName <bool>
Specifies if 'Remove session number from printer name' option is enabled or disabled. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-RemoveClientNameFromPrinterName <bool>
Specifies if 'Remove client name from printer name' option is enabled or disabled. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-AppMonitor <bool>
Specifies if 'Allow Application Monitoring' option is enabled or disabled. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-ManageRDPShortpath <bool>
Specifies if 'Allow RDP Shortpath' option is enabled or disabled. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-UseRDPShortpath <bool>
Specifies if 'Allow RDP Shortpath' option is enabled or disabled. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-UseSmallerPortRange <bool>
Specifies if 'Use Smaller Port' option is enabled or disabled. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-MinRDPShortpathPort <uint>
The minimum RDP Shortpath Port. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-MaxRDPShortpathPort <uint>
The maximum RDP Shortpath Port. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-InheritDefaultAgentSettings <bool>
If true, default AVD Agent settings will be inherited. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-InheritDefaultUserProfileSettings <bool>
If true, default User Profile settings will be inherited. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-InheritDefaultAppPackageSettings <bool>
If true, default Application Package settings will be inherited. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-InheritDefaultOptimizationSettings <bool>
If true, default Optimization settings will be inherited. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-InheritDefaultActionsSettings <bool>
If true, default Action settings will be inherited. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-InheritDefaultRDPPrinterSettings <bool>
If true, default Printing settings will be inherited. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

<CommonParameters> 
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see 
        about_CommonParameters documentation.

INPUTS

AVDHostPool

OUTPUTS

-none-

EXAMPLES


---------- EXAMPLE 1 ----------

Set-RASAVDHostPool -NewName NewHostPool

Modifies the name of the Azure Virtual Desktop Host Pool.

RELATED LINKS